<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.9" />
<title>lockfile API</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }


/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}


/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>lockfile API</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>The lockfile API serves two purposes:</p></div>
<div class="ulist"><ul>
<li>
<p>
Mutual exclusion and atomic file updates. When we want to change a
  file, we create a lockfile <code>&lt;filename&gt;.lock</code>, write the new file
  contents into it, and then rename the lockfile to its final
  destination <code>&lt;filename&gt;</code>. We create the <code>&lt;filename&gt;.lock</code> file with
  <code>O_CREAT|O_EXCL</code> so that we can notice and fail if somebody else has
  already locked the file, then atomically rename the lockfile to its
  final destination to commit the changes and unlock the file.
</p>
</li>
<li>
<p>
Automatic cruft removal. If the program exits after we lock a file
  but before the changes have been committed, we want to make sure
  that we remove the lockfile. This is done by remembering the
  lockfiles we have created in a linked list and setting up an
  <code>atexit(3)</code> handler and a signal handler that clean up the
  lockfiles. This mechanism ensures that outstanding lockfiles are
  cleaned up if the program exits (including when <code>die()</code> is called)
  or if the program dies on a signal.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Please note that lockfiles only block other writers. Readers do not
block, but they are guaranteed to see either the old contents of the
file or the new contents of the file (assuming that the filesystem
implements <code>rename(2)</code> atomically).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_calling_sequence">Calling sequence</h2>
<div class="sectionbody">
<div class="paragraph"><p>The caller:</p></div>
<div class="ulist"><ul>
<li>
<p>
Allocates a <code>struct lock_file</code> either as a static variable or on the
  heap, initialized to zeros. Once you use the structure to call the
  <code>hold_lock_file_*</code> family of functions, it belongs to the lockfile
  subsystem and its storage must remain valid throughout the life of
  the program (i.e. you cannot use an on-stack variable to hold this
  structure).
</p>
</li>
<li>
<p>
Attempts to create a lockfile by passing that variable and the path
  of the final destination (e.g. <code>$GIT_DIR/index</code>) to
  <code>hold_lock_file_for_update</code> or <code>hold_lock_file_for_append</code>.
</p>
</li>
<li>
<p>
Writes new content for the destination file by either:
</p>
</li>
<li>
<p>
writing to the file descriptor returned by the <code>hold_lock_file_*</code>
    functions (also available via <code>lock-&gt;fd</code>).
</p>
</li>
<li>
<p>
calling <code>fdopen_lock_file</code> to get a <code>FILE</code> pointer for the open
    file and writing to the file using stdio.
</p>
</li>
</ul></div>
<div class="paragraph"><p>When finished writing, the caller can:</p></div>
<div class="ulist"><ul>
<li>
<p>
Close the file descriptor and rename the lockfile to its final
  destination by calling <code>commit_lock_file</code> or <code>commit_lock_file_to</code>.
</p>
</li>
<li>
<p>
Close the file descriptor and remove the lockfile by calling
  <code>rollback_lock_file</code>.
</p>
</li>
<li>
<p>
Close the file descriptor without removing or renaming the lockfile
  by calling <code>close_lock_file</code>, and later call <code>commit_lock_file</code>,
  <code>commit_lock_file_to</code>, <code>rollback_lock_file</code>, or <code>reopen_lock_file</code>.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Even after the lockfile is committed or rolled back, the <code>lock_file</code>
object must not be freed or altered by the caller. However, it may be
reused; just pass it to another call of <code>hold_lock_file_for_update</code> or
<code>hold_lock_file_for_append</code>.</p></div>
<div class="paragraph"><p>If the program exits before you have called one of <code>commit_lock_file</code>,
<code>commit_lock_file_to</code>, <code>rollback_lock_file</code>, or <code>close_lock_file</code>, an
<code>atexit(3)</code> handler will close and remove the lockfile, rolling back
any uncommitted changes.</p></div>
<div class="paragraph"><p>If you need to close the file descriptor you obtained from a
<code>hold_lock_file_*</code> function yourself, do so by calling
<code>close_lock_file</code>. You should never call <code>close(2)</code> or <code>fclose(3)</code>
yourself! Otherwise the <code>struct lock_file</code> structure would still think
that the file descriptor needs to be closed, and a commit or rollback
would result in duplicate calls to <code>close(2)</code>. Worse yet, if you close
and then later open another file descriptor for a completely different
purpose, then a commit or rollback might close that unrelated file
descriptor.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_error_handling">Error handling</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <code>hold_lock_file_*</code> functions return a file descriptor on success
or -1 on failure (unless <code>LOCK_DIE_ON_ERROR</code> is used; see below). On
errors, <code>errno</code> describes the reason for failure. Errors can be
reported by passing <code>errno</code> to one of the following helper functions:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
unable_to_lock_message
</dt>
<dd>
<p>
        Append an appropriate error message to a <code>strbuf</code>.
</p>
</dd>
<dt class="hdlist1">
unable_to_lock_error
</dt>
<dd>
<p>
        Emit an appropriate error message using <code>error()</code>.
</p>
</dd>
<dt class="hdlist1">
unable_to_lock_die
</dt>
<dd>
<p>
        Emit an appropriate error message and <code>die()</code>.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Similarly, <code>commit_lock_file</code>, <code>commit_lock_file_to</code>, and
<code>close_lock_file</code> return 0 on success. On failure they set <code>errno</code>
appropriately, do their best to roll back the lockfile, and return -1.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_flags">Flags</h2>
<div class="sectionbody">
<div class="paragraph"><p>The following flags can be passed to <code>hold_lock_file_for_update</code> or
<code>hold_lock_file_for_append</code>:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
LOCK_NO_DEREF
</dt>
<dd>
<p>
        Usually symbolic links in the destination path are resolved
        and the lockfile is created by adding ".lock" to the resolved
        path. If <code>LOCK_NO_DEREF</code> is set, then the lockfile is created
        by adding ".lock" to the path argument itself. This option is
        used, for example, when locking a symbolic reference, which
        for backwards-compatibility reasons can be a symbolic link
        containing the name of the referred-to-reference.
</p>
</dd>
<dt class="hdlist1">
LOCK_DIE_ON_ERROR
</dt>
<dd>
<p>
        If a lock is already taken for the file, <code>die()</code> with an error
        message. If this option is not specified, trying to lock a
        file that is already locked returns -1 to the caller.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_the_functions">The functions</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
hold_lock_file_for_update
</dt>
<dd>
<p>
        Take a pointer to <code>struct lock_file</code>, the path of the file to
        be locked (e.g. <code>$GIT_DIR/index</code>) and a flags argument (see
        above). Attempt to create a lockfile for the destination and
        return the file descriptor for writing to the file.
</p>
</dd>
<dt class="hdlist1">
hold_lock_file_for_append
</dt>
<dd>
<p>
        Like <code>hold_lock_file_for_update</code>, but before returning copy
        the existing contents of the file (if any) to the lockfile and
        position its write pointer at the end of the file.
</p>
</dd>
<dt class="hdlist1">
fdopen_lock_file
</dt>
<dd>
<p>
        Associate a stdio stream with the lockfile. Return NULL
        (<strong>without</strong> rolling back the lockfile) on error. The stream is
        closed automatically when <code>close_lock_file</code> is called or when
        the file is committed or rolled back.
</p>
</dd>
<dt class="hdlist1">
get_locked_file_path
</dt>
<dd>
<p>
        Return the path of the file that is locked by the specified
        lock_file object. The caller must free the memory.
</p>
</dd>
<dt class="hdlist1">
commit_lock_file
</dt>
<dd>
<p>
        Take a pointer to the <code>struct lock_file</code> initialized with an
        earlier call to <code>hold_lock_file_for_update</code> or
        <code>hold_lock_file_for_append</code>, close the file descriptor, and
        rename the lockfile to its final destination. Return 0 upon
        success. On failure, roll back the lock file and return -1,
        with <code>errno</code> set to the value from the failing call to
        <code>close(2)</code> or <code>rename(2)</code>. It is a bug to call
        <code>commit_lock_file</code> for a <code>lock_file</code> object that is not
        currently locked.
</p>
</dd>
<dt class="hdlist1">
commit_lock_file_to
</dt>
<dd>
<p>
        Like <code>commit_lock_file()</code>, except that it takes an explicit
        <code>path</code> argument to which the lockfile should be renamed. The
        <code>path</code> must be on the same filesystem as the lock file.
</p>
</dd>
<dt class="hdlist1">
rollback_lock_file
</dt>
<dd>
<p>
        Take a pointer to the <code>struct lock_file</code> initialized with an
        earlier call to <code>hold_lock_file_for_update</code> or
        <code>hold_lock_file_for_append</code>, close the file descriptor and
        remove the lockfile. It is a NOOP to call
        <code>rollback_lock_file()</code> for a <code>lock_file</code> object that has
        already been committed or rolled back.
</p>
</dd>
<dt class="hdlist1">
close_lock_file
</dt>
<dd>
<p>
        Take a pointer to the <code>struct lock_file</code> initialized with an
        earlier call to <code>hold_lock_file_for_update</code> or
        <code>hold_lock_file_for_append</code>. Close the file descriptor (and
        the file pointer if it has been opened using
        <code>fdopen_lock_file</code>). Return 0 upon success. On failure to
        <code>close(2)</code>, return a negative value and roll back the lock
        file. Usually <code>commit_lock_file</code>, <code>commit_lock_file_to</code>, or
        <code>rollback_lock_file</code> should eventually be called if
        <code>close_lock_file</code> succeeds.
</p>
</dd>
<dt class="hdlist1">
reopen_lock_file
</dt>
<dd>
<p>
        Re-open a lockfile that has been closed (using
        <code>close_lock_file</code>) but not yet committed or rolled back. This
        can be used to implement a sequence of operations like the
        following:
</p>
<div class="ulist"><ul>
<li>
<p>
Lock file.
</p>
</li>
<li>
<p>
Write new contents to lockfile, then <code>close_lock_file</code> to
          cause the contents to be written to disk.
</p>
</li>
<li>
<p>
Pass the name of the lockfile to another program to allow it
          (and nobody else) to inspect the contents you wrote, while
          still holding the lock yourself.
</p>
</li>
<li>
<p>
<code>reopen_lock_file</code> to reopen the lockfile. Make further
          updates to the contents.
</p>
</li>
<li>
<p>
<code>commit_lock_file</code> to make the final version permanent.
</p>
</li>
</ul></div>
</dd>
</dl></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-10-14 15:27:06 PDT
</div>
</div>
</body>
</html>
